<HTML><HEAD><TITLE>XmlRpcStream.js</TITLE></HEAD><BODY>
<A NAME="_top_"></A><PRE><A HREF="index.html">Index Files</A> </PRE><HR/>
<H1>File XmlRpcStream.js</H1>
 Provides a class used to read/write XMLRPC web services data streams. This implementation is focused on web service client requirements, it means that it is only able to write requests and read responses. This implementation support all XMLRPC datatypes. <P><DL><DT><B>Author:</B></DT><DD>Carlos Eduardo Goncalves</DD></DL></P>
<HR/>
<A HREF=#XmlRpcStream>XmlRpcStream</A><BR/>
<A HREF=#XmlRpcStream.prototype.faultValue>XmlRpcStream.prototype.faultValue</A><BR/>
<A HREF=#XmlRpcStream.prototype.getName>XmlRpcStream.prototype.getName</A><BR/>
<A HREF=#XmlRpcStream.prototype.propertyName>XmlRpcStream.prototype.propertyName</A><BR/>
<A HREF=#XmlRpcStream.prototype.params>XmlRpcStream.prototype.params</A><BR/>
<A HREF=#XmlRpcStream.PROLOG >XmlRpcStream.PROLOG </A><BR/>
<A HREF=#XmlRpcStream.REQUEST >XmlRpcStream.REQUEST </A><BR/>
<A HREF=#XmlRpcStream.PARAM >XmlRpcStream.PARAM </A><BR/>
<A HREF=#XmlRpcStream.ARRAY >XmlRpcStream.ARRAY </A><BR/>
<A HREF=#XmlRpcStream.STRUCT >XmlRpcStream.STRUCT </A><BR/>
<A HREF=#XmlRpcStream.MEMBER >XmlRpcStream.MEMBER </A><BR/>
<A HREF=#XmlRpcStream.NAME >XmlRpcStream.NAME </A><BR/>
<A HREF=#XmlRpcStream.VALUE >XmlRpcStream.VALUE </A><BR/>
<A HREF=#XmlRpcStream.SCALAR >XmlRpcStream.SCALAR </A><BR/>
<A HREF=#XmlRpcStream.prototype.write>XmlRpcStream.prototype.write</A><BR/>
<A HREF=#XmlRpcStream.prototype.read>XmlRpcStream.prototype.read</A><BR/>
<A HREF=#XmlRpcStream.prototype.serialize>XmlRpcStream.prototype.serialize</A><BR/>
<A HREF=#XmlRpcStream.prototype.unserialize>XmlRpcStream.prototype.unserialize</A><BR/>
<A HREF=#XmlRpcStream.prototype.getDataTag>XmlRpcStream.prototype.getDataTag</A><BR/>
<A HREF=#XmlRpcStream.prototype.getTagData>XmlRpcStream.prototype.getTagData</A><BR/>
<HR/>
<A NAME=XmlRpcStream></A>
<H2>Constructor XmlRpcStream</H2><PRE>function XmlRpcStream()</PRE><p>Xmlrpc stream constructor.</p><P></P><BR/><BR/>
<A NAME=XmlRpcStream.prototype.faultValue></A>
<H2> Attribute XmlRpcStream.prototype.faultValue</H2><PRE>XmlRpcStream.prototype.faultValue</PRE> <p>Register if there is a fault.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.prototype.getName></A>
<H2> Attribute XmlRpcStream.prototype.getName</H2><PRE>XmlRpcStream.prototype.getName</PRE> <p>Register if current node is a name.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.prototype.propertyName></A>
<H2> Attribute XmlRpcStream.prototype.propertyName</H2><PRE>XmlRpcStream.prototype.propertyName</PRE> <p>Hold a parsed property.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.prototype.params></A>
<H2> Attribute XmlRpcStream.prototype.params</H2><PRE>XmlRpcStream.prototype.params</PRE> <p>Store parsed params.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.PROLOG ></A>
<H2> Attribute XmlRpcStream.PROLOG </H2><PRE>XmlRpcStream.PROLOG </PRE> <p>Xmlrpc document prolog.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.REQUEST ></A>
<H2> Attribute XmlRpcStream.REQUEST </H2><PRE>XmlRpcStream.REQUEST </PRE> <p>Xmlrpc methodCall node template.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.PARAM ></A>
<H2> Attribute XmlRpcStream.PARAM </H2><PRE>XmlRpcStream.PARAM </PRE> <p>Xmlrpc param node template.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.ARRAY ></A>
<H2> Attribute XmlRpcStream.ARRAY </H2><PRE>XmlRpcStream.ARRAY </PRE> <p>Xmlrpc array node template.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.STRUCT ></A>
<H2> Attribute XmlRpcStream.STRUCT </H2><PRE>XmlRpcStream.STRUCT </PRE> <p>Xmlrpc struct node template.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.MEMBER ></A>
<H2> Attribute XmlRpcStream.MEMBER </H2><PRE>XmlRpcStream.MEMBER </PRE> <p>Xmlrpc member node template.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.NAME ></A>
<H2> Attribute XmlRpcStream.NAME </H2><PRE>XmlRpcStream.NAME </PRE> <p>Xmlrpc name node template.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.VALUE ></A>
<H2> Attribute XmlRpcStream.VALUE </H2><PRE>XmlRpcStream.VALUE </PRE> <p>Xmlrpc value node template.</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.SCALAR ></A>
<H2> Attribute XmlRpcStream.SCALAR </H2><PRE>XmlRpcStream.SCALAR </PRE> <p>Xmlrpc scalar node template (int, i4, double, string, boolean, base64, dateTime.iso8601).</p> <P></P><BR/><BR/>
<A NAME=XmlRpcStream.prototype.write></A>
<H2> Method XmlRpcStream.prototype.write</H2><PRE>XmlRpcStream.prototype.write = function(method)</PRE> <p>Write a XMLRPC document.</p> <P><TABLE WIDTH="90%" BORDER=1><TR BGCOLOR=#BDB3C4><TD><B>Parameter</B></TD><TD><B>Description</B></TD></TR><TR><TD><I>method</I></TD><TD><code>RemoteMethod</code> value object. </TD></TR></TABLE><DL><DT><B>Returns:</B></DT><DD><code>XMLDocument</code> instance that is a valid XMLRPC document.</DD></DL></P><BR/><BR/>
<A NAME=XmlRpcStream.prototype.read></A>
<H2> Method XmlRpcStream.prototype.read</H2><PRE>XmlRpcStream.prototype.read = function(doc)</PRE> <p>Read a XMLRPC document.</p> <P><TABLE WIDTH="90%" BORDER=1><TR BGCOLOR=#BDB3C4><TD><B>Parameter</B></TD><TD><B>Description</B></TD></TR><TR><TD><I>doc</I></TD><TD><code>XMLDocument</code> to read. </TD></TR></TABLE><DL><DT><B>Returns:</B></DT><DD>JavaScript object tree.</DD></DL></P><BR/><BR/>
<A NAME=XmlRpcStream.prototype.serialize></A>
<H2> Method XmlRpcStream.prototype.serialize</H2><PRE>XmlRpcStream.prototype.serialize = function(data)</PRE> <p>Encode a JavaScript object to a compatible XMLRPC representation.</p> <P><TABLE WIDTH="90%" BORDER=1><TR BGCOLOR=#BDB3C4><TD><B>Parameter</B></TD><TD><B>Description</B></TD></TR><TR><TD><I>data</I></TD><TD>JavaScript object to be encoded. </TD></TR></TABLE><DL><DT><B>Returns:</B></DT><DD><code>String</code> with XMLRPC object representation.</DD></DL></P><BR/><BR/>
<A NAME=XmlRpcStream.prototype.unserialize></A>
<H2> Method XmlRpcStream.prototype.unserialize</H2><PRE>XmlRpcStream.prototype.unserialize = function(node, parent)</PRE> <p>Decode XMLRPC representation to a compatible JavaScript object.</p> <P><TABLE WIDTH="90%" BORDER=1><TR BGCOLOR=#BDB3C4><TD><B>Parameter</B></TD><TD><B>Description</B></TD></TR><TR><TD><I>node</I></TD><TD><code>XMLDocument</code> current <code>Node</code>. </TD></TR><TR><TD><I>parent</I></TD><TD><code>XMLDocument</code> current parent <code>Node</code>. </TD></TR></TABLE><DL><DT><B>Returns:</B></DT><DD>JavaScript object tree. </DD></DL></P><BR/><BR/>
<A NAME=XmlRpcStream.prototype.getDataTag></A>
<H2> Method XmlRpcStream.prototype.getDataTag</H2><PRE>XmlRpcStream.prototype.getDataTag = function(data)</PRE> <p>Get the tag name used to represent a JavaScript object in the XMLRPC protocol.</p> <P><TABLE WIDTH="90%" BORDER=1><TR BGCOLOR=#BDB3C4><TD><B>Parameter</B></TD><TD><B>Description</B></TD></TR><TR><TD><I>data</I></TD><TD>A JavaScript object. </TD></TR></TABLE><DL><DT><B>Returns:</B></DT><DD><code>String</code> with XMLRPC object type.</DD></DL></P><BR/><BR/>
<A NAME=XmlRpcStream.prototype.getTagData></A>
<H2> Method XmlRpcStream.prototype.getTagData</H2><PRE>XmlRpcStream.prototype.getTagData = function(tag)</PRE> <p>Get JavaScript object type represented by  XMLRPC protocol tag.<p> <P><TABLE WIDTH="90%" BORDER=1><TR BGCOLOR=#BDB3C4><TD><B>Parameter</B></TD><TD><B>Description</B></TD></TR><TR><TD><I>tag</I></TD><TD>A XMLRPC tag name. </TD></TR></TABLE><DL><DT><B>Returns:</B></DT><DD>A JavaScript object.</DD></DL></P><BR/><BR/>
</BODY></HTML>
